home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Programming / Python1.4_Source / Include / object.h < prev    next >
C/C++ Source or Header  |  1998-06-24  |  16KB  |  469 lines
  1. #ifndef Py_OBJECT_H
  2. #define Py_OBJECT_H
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6.  
  7. /***********************************************************
  8. Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
  9. The Netherlands.
  10.  
  11.                         All Rights Reserved
  12.  
  13. Permission to use, copy, modify, and distribute this software and its
  14. documentation for any purpose and without fee is hereby granted,
  15. provided that the above copyright notice appear in all copies and that
  16. both that copyright notice and this permission notice appear in
  17. supporting documentation, and that the names of Stichting Mathematisch
  18. Centrum or CWI or Corporation for National Research Initiatives or
  19. CNRI not be used in advertising or publicity pertaining to
  20. distribution of the software without specific, written prior
  21. permission.
  22.  
  23. While CWI is the initial source for this software, a modified version
  24. is made available by the Corporation for National Research Initiatives
  25. (CNRI) at the Internet address ftp://ftp.python.org.
  26.  
  27. STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
  28. REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
  29. MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
  30. CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  31. DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  32. PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  33. TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  34. PERFORMANCE OF THIS SOFTWARE.
  35.  
  36. ******************************************************************/
  37.  
  38. /* Object and type object interface */
  39.  
  40. /*
  41. 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  42.  
  43. Objects are structures allocated on the heap.  Special rules apply to
  44. the use of objects to ensure they are properly garbage-collected.
  45. Objects are never allocated statically or on the stack; they must be
  46. accessed through special macros and functions only.  (Type objects are
  47. exceptions to the first rule; the standard types are represented by
  48. statically initialized type objects.)
  49.  
  50. An object has a 'reference count' that is increased or decreased when a
  51. pointer to the object is copied or deleted; when the reference count
  52. reaches zero there are no references to the object left and it can be
  53. removed from the heap.
  54.  
  55. An object has a 'type' that determines what it represents and what kind
  56. of data it contains.  An object's type is fixed when it is created.
  57. Types themselves are represented as objects; an object contains a
  58. pointer to the corresponding type object.  The type itself has a type
  59. pointer pointing to the object representing the type 'type', which
  60. contains a pointer to itself!).
  61.  
  62. Objects do not float around in memory; once allocated an object keeps
  63. the same size and address.  Objects that must hold variable-size data
  64. can contain pointers to variable-size parts of the object.  Not all
  65. objects of the same type have the same size; but the size cannot change
  66. after allocation.  (These restrictions are made so a reference to an
  67. object can be simply a pointer -- moving an object would require
  68. updating all the pointers, and changing an object's size would require
  69. moving it if there was another object right next to it.)
  70.  
  71. Objects are always accessed through pointers of the type 'PyObject *'.
  72. The type 'PyObject' is a structure that only contains the reference count
  73. and the type pointer.  The actual memory allocated for an object
  74. contains other data that can only be accessed after casting the pointer
  75. to a pointer to a longer structure type.  This longer type must start
  76. with the reference count and type fields; the macro PyObject_HEAD should be
  77. used for this (to accomodate for future changes).  The implementation
  78. of a particular object type can cast the object pointer to the proper
  79. type and back.
  80.  
  81. A standard interface exists for objects that contain an array of items
  82. whose size is determined when the object is allocated.
  83.  
  84. 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  85. */
  86.  
  87. #ifdef DEBUG
  88.  
  89. /* Turn on heavy reference debugging */
  90. #define Py_TRACE_REFS
  91.  
  92. /* Turn on reference counting */
  93. #define Py_REF_DEBUG
  94.  
  95. #endif /* DEBUG */
  96.  
  97. #ifdef Py_TRACE_REFS
  98. #define PyObject_HEAD \
  99.     struct _object *_ob_next, *_ob_prev; \
  100.     int ob_refcnt; \
  101.     struct _typeobject *ob_type;
  102. #define PyObject_HEAD_INIT(type) 0, 0, 1, type,
  103. #else /* !Py_TRACE_REFS */
  104. #define PyObject_HEAD \
  105.     int ob_refcnt; \
  106.     struct _typeobject *ob_type;
  107. #define PyObject_HEAD_INIT(type) 1, type,
  108. #endif /* !Py_TRACE_REFS */
  109.  
  110. #define PyObject_VAR_HEAD \
  111.     PyObject_HEAD \
  112.     int ob_size; /* Number of items in variable part */
  113.  
  114. typedef struct _object {
  115.     PyObject_HEAD
  116. } PyObject;
  117.  
  118. typedef struct {
  119.     PyObject_VAR_HEAD
  120. } varobject;
  121.  
  122.  
  123. /*
  124. 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  125.  
  126. Type objects contain a string containing the type name (to help somewhat
  127. in debugging), the allocation parameters (see newobj() and newvarobj()),
  128. and methods for accessing objects of the type.  Methods are optional,a
  129. nil pointer meaning that particular kind of access is not available for
  130. this type.  The Py_DECREF() macro uses the tp_dealloc method without
  131. checking for a nil pointer; it should always be implemented except if
  132. the implementation can guarantee that the reference count will never
  133. reach zero (e.g., for type objects).
  134.  
  135. NB: the methods for certain type groups are now contained in separate
  136. method blocks.
  137. */
  138.  
  139. typedef PyObject * (*unaryfunc) Py_PROTO((PyObject *));
  140. typedef PyObject * (*binaryfunc) Py_PROTO((PyObject *, PyObject *));
  141. typedef PyObject * (*ternaryfunc) Py_PROTO((PyObject *, PyObject *, PyObject *));
  142. typedef int (*inquiry) Py_PROTO((PyObject *));
  143. typedef int (*coercion) Py_PROTO((PyObject **, PyObject **));
  144. typedef PyObject *(*intargfunc) Py_PROTO((PyObject *, int));
  145. typedef PyObject *(*intintargfunc) Py_PROTO((PyObject *, int, int));
  146. typedef int(*intobjargproc) Py_PROTO((PyObject *, int, PyObject *));
  147. typedef int(*intintobjargproc) Py_PROTO((PyObject *, int, int, PyObject *));
  148. typedef int(*objobjargproc) Py_PROTO((PyObject *, PyObject *, PyObject *));
  149.  
  150. typedef struct {
  151.     binaryfunc nb_add;
  152.     binaryfunc nb_subtract;
  153.     binaryfunc nb_multiply;
  154.     binaryfunc nb_divide;
  155.     binaryfunc nb_remainder;
  156.     binaryfunc nb_divmod;
  157.     ternaryfunc nb_power;
  158.     unaryfunc nb_negative;
  159.     unaryfunc nb_positive;
  160.     unaryfunc nb_absolute;
  161.     inquiry nb_nonzero;
  162.     unaryfunc nb_invert;
  163.     binaryfunc nb_lshift;
  164.     binaryfunc nb_rshift;
  165.     binaryfunc nb_and;
  166.     binaryfunc nb_xor;
  167.     binaryfunc nb_or;
  168.     coercion nb_coerce;
  169.     unaryfunc nb_int;
  170.     unaryfunc nb_long;
  171.     unaryfunc nb_float;
  172.     unaryfunc nb_oct;
  173.     unaryfunc nb_hex;
  174. } PyNumberMethods;
  175.  
  176. typedef struct {
  177.     inquiry sq_length;
  178.     binaryfunc sq_concat;
  179.     intargfunc sq_repeat;
  180.     intargfunc sq_item;
  181.     intintargfunc sq_slice;
  182.     intobjargproc sq_ass_item;
  183.     intintobjargproc sq_ass_slice;
  184. } PySequenceMethods;
  185.  
  186. typedef struct {
  187.     inquiry mp_length;
  188.     binaryfunc mp_subscript;
  189.     objobjargproc mp_ass_subscript;
  190. } PyMappingMethods;
  191.  
  192. typedef void (*destructor) Py_PROTO((PyObject *));
  193. typedef int (*printfunc) Py_PROTO((PyObject *, FILE *, int));
  194. typedef PyObject *(*getattrfunc) Py_PROTO((PyObject *, char *));
  195. typedef PyObject *(*getattrofunc) Py_PROTO((PyObject *, PyObject *));
  196. typedef int (*setattrfunc) Py_PROTO((PyObject *, char *, PyObject *));
  197. typedef int (*setattrofunc) Py_PROTO((PyObject *, PyObject *, PyObject *));
  198. typedef int (*cmpfunc) Py_PROTO((PyObject *, PyObject *));
  199. typedef PyObject *(*reprfunc) Py_PROTO((PyObject *));
  200. typedef long (*hashfunc) Py_PROTO((PyObject *));
  201.  
  202. typedef struct _typeobject {
  203.     PyObject_VAR_HEAD
  204.     char *tp_name; /* For printing */
  205.     int tp_basicsize, tp_itemsize; /* For allocation */
  206.     
  207.     /* Methods to implement standard operations */
  208.     
  209.     destructor tp_dealloc;
  210.     printfunc tp_print;
  211.     getattrfunc tp_getattr;
  212.     setattrfunc tp_setattr;
  213.     cmpfunc tp_compare;
  214.     reprfunc tp_repr;
  215.     
  216.     /* Method suites for standard classes */
  217.     
  218.     PyNumberMethods *tp_as_number;
  219.     PySequenceMethods *tp_as_sequence;
  220.     PyMappingMethods *tp_as_mapping;
  221.  
  222.     /* More standard operations (at end for binary compatibility) */
  223.  
  224.     hashfunc tp_hash;
  225.     ternaryfunc tp_call;
  226.     reprfunc tp_str;
  227.     getattrofunc tp_getattro;
  228.     setattrofunc tp_setattro;
  229.  
  230.     /* Space for future expansion */
  231.     long tp_xxx3;
  232.     long tp_xxx4;
  233.  
  234.     char *tp_doc; /* Documentation string */
  235.  
  236. #ifdef COUNT_ALLOCS
  237.     /* these must be last */
  238.     int tp_alloc;
  239.     int tp_free;
  240.     int tp_maxalloc;
  241.     struct _typeobject *tp_next;
  242. #endif
  243. } PyTypeObject;
  244.  
  245. extern DL_IMPORT(PyTypeObject) PyType_Type; /* The type of type objects */
  246.  
  247. #define PyType_Check(op) ((op)->ob_type == &PyType_Type)
  248.  
  249. /* Generic operations on objects */
  250. extern int PyObject_Print Py_PROTO((PyObject *, FILE *, int));
  251. extern PyObject * PyObject_Repr Py_PROTO((PyObject *));
  252. extern PyObject * PyObject_Str Py_PROTO((PyObject *));
  253. extern int PyObject_Compare Py_PROTO((PyObject *, PyObject *));
  254. extern PyObject *PyObject_GetAttrString Py_PROTO((PyObject *, char *));
  255. extern int PyObject_SetAttrString Py_PROTO((PyObject *, char *, PyObject *));
  256. extern int PyObject_HasAttrString Py_PROTO((PyObject *, char *));
  257. extern PyObject *PyObject_GetAttr Py_PROTO((PyObject *, PyObject *));
  258. extern int PyObject_SetAttr Py_PROTO((PyObject *, PyObject *, PyObject *));
  259. extern long PyObject_Hash Py_PROTO((PyObject *));
  260. extern int PyObject_IsTrue Py_PROTO((PyObject *));
  261. extern int PyCallable_Check Py_PROTO((PyObject *));
  262. extern int PyNumber_Coerce Py_PROTO((PyObject **, PyObject **));
  263.  
  264. /* Flag bits for printing: */
  265. #define Py_PRINT_RAW    1    /* No string quotes etc. */
  266.  
  267. /*
  268. 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  269.  
  270. The macros Py_INCREF(op) and Py_DECREF(op) are used to increment or decrement
  271. reference counts.  Py_DECREF calls the object's deallocator function; for
  272. objects that don't contain references to other objects or heap memory
  273. this can be the standard function free().  Both macros can be used
  274. whereever a void expression is allowed.  The argument shouldn't be a
  275. NIL pointer.  The macro _Py_NewReference(op) is used only to initialize
  276. reference counts to 1; it is defined here for convenience.
  277.  
  278. We assume that the reference count field can never overflow; this can
  279. be proven when the size of the field is the same as the pointer size
  280. but even with a 16-bit reference count field it is pretty unlikely so
  281. we ignore the possibility.  (If you are paranoid, make it a long.)
  282.  
  283. Type objects should never be deallocated; the type pointer in an object
  284. is not considered to be a reference to the type object, to save
  285. complications in the deallocation function.  (This is actually a
  286. decision that's up to the implementer of each new type so if you want,
  287. you can count such references to the type object.)
  288.  
  289. *** WARNING*** The Py_DECREF macro must have a side-effect-free argument
  290. since it may evaluate its argument multiple times.  (The alternative
  291. would be to mace it a proper function or assign it to a global temporary
  292. variable first, both of which are slower; and in a multi-threaded
  293. environment the global variable trick is not safe.)
  294. */
  295.  
  296. #ifdef Py_TRACE_REFS
  297. #ifndef Py_REF_DEBUG
  298. #define Py_REF_DEBUG
  299. #endif
  300. #endif
  301.  
  302. #ifdef Py_TRACE_REFS
  303. extern void _Py_Dealloc Py_PROTO((PyObject *));
  304. extern void _Py_NewReference Py_PROTO((PyObject *));
  305. extern void _Py_ForgetReference Py_PROTO((PyObject *));
  306. extern void _Py_PrintReferences Py_PROTO((FILE *));
  307. #endif
  308.  
  309. #ifndef Py_TRACE_REFS
  310. #ifdef COUNT_ALLOCS
  311. #define _Py_Dealloc(op) ((op)->ob_type->tp_free++, (*(op)->ob_type->tp_dealloc)((PyObject *)(op)))
  312. #define _Py_ForgetReference(op) ((op)->ob_type->tp_free++)
  313. #else /* !COUNT_ALLOCS */
  314. #define _Py_Dealloc(op) (*(op)->ob_type->tp_dealloc)((PyObject *)(op))
  315. #define _Py_ForgetReference(op) /*empty*/
  316. #endif /* !COUNT_ALLOCS */
  317. #endif /* !Py_TRACE_REFS */
  318.  
  319. #ifdef COUNT_ALLOCS
  320. extern void inc_count Py_PROTO((PyTypeObject *));
  321. #endif
  322.  
  323. #ifdef Py_REF_DEBUG
  324.  
  325. extern long _Py_RefTotal;
  326.  
  327. #ifndef Py_TRACE_REFS
  328. #ifdef COUNT_ALLOCS
  329. #define _Py_NewReference(op) (inc_count((op)->ob_type), _Py_RefTotal++, (op)->ob_refcnt = 1)
  330. #else
  331. #define _Py_NewReference(op) (_Py_RefTotal++, (op)->ob_refcnt = 1)
  332. #endif
  333. #endif /* !Py_TRACE_REFS */
  334.  
  335. #define Py_INCREF(op) (_Py_RefTotal++, (op)->ob_refcnt++)
  336. #define Py_DECREF(op) \
  337.     if (--_Py_RefTotal, --(op)->ob_refcnt != 0) \
  338.         ; \
  339.     else \
  340.         _Py_Dealloc(op)
  341. #else /* !Py_REF_DEBUG */
  342.  
  343. #ifdef COUNT_ALLOCS
  344. #define _Py_NewReference(op) (inc_count((op)->ob_type), (op)->ob_refcnt = 1)
  345. #else
  346. #define _Py_NewReference(op) ((op)->ob_refcnt = 1)
  347. #endif
  348.  
  349. #define Py_INCREF(op) ((op)->ob_refcnt++)
  350. #define Py_DECREF(op) \
  351.     if (--(op)->ob_refcnt != 0) \
  352.         ; \
  353.     else \
  354.         _Py_Dealloc(op)
  355. #endif /* !Py_REF_DEBUG */
  356.  
  357. /* Macros to use in case the object pointer may be NULL: */
  358.  
  359. #define Py_XINCREF(op) if ((op) == NULL) ; else Py_INCREF(op)
  360. #define Py_XDECREF(op) if ((op) == NULL) ; else Py_DECREF(op)
  361.  
  362. /* Definition of NULL, so you don't have to include <stdio.h> */
  363.  
  364. #ifndef NULL
  365. #define NULL 0
  366. #endif
  367.  
  368.  
  369. /*
  370. _Py_NoneStruct is an object of undefined type which can be used in contexts
  371. where NULL (nil) is not suitable (since NULL often means 'error').
  372.  
  373. Don't forget to apply Py_INCREF() when returning this value!!!
  374. */
  375.  
  376. extern DL_IMPORT(PyObject) _Py_NoneStruct; /* Don't use this directly */
  377.  
  378. #define Py_None (&_Py_NoneStruct)
  379.  
  380.  
  381. /*
  382. A common programming style in Python requires the forward declaration
  383. of static, initialized structures, e.g. for a type object that is used
  384. by the functions whose address must be used in the initializer.
  385. Some compilers (notably SCO ODT 3.0, I seem to remember early AIX as
  386. well) botch this if you use the static keyword for both declarations
  387. (they allocate two objects, and use the first, uninitialized one until
  388. the second declaration is encountered).  Therefore, the forward
  389. declaration should use the 'forwardstatic' keyword.  This expands to
  390. static on most systems, but to extern on a few.  The actual storage
  391. and name will still be static because the second declaration is
  392. static, so no linker visible symbols will be generated.  (Standard C
  393. compilers take offense to the extern forward declaration of a static
  394. object, so I can't just put extern in all cases. :-( )
  395. */
  396.  
  397. #ifdef BAD_STATIC_FORWARD
  398. #define staticforward extern
  399. #ifdef __SC__
  400. #define statichere
  401. #else
  402. #define statichere static
  403. #endif /* __SC__ */
  404. #else /* !BAD_STATIC_FORWARD */
  405. #define staticforward static
  406. #define statichere static
  407. #endif /* !BAD_STATIC_FORWARD */
  408.  
  409.  
  410. /*
  411. 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  412.  
  413. More conventions
  414. ================
  415.  
  416. Argument Checking
  417. -----------------
  418.  
  419. Functions that take objects as arguments normally don't check for nil
  420. arguments, but they do check the type of the argument, and return an
  421. error if the function doesn't apply to the type.
  422.  
  423. Failure Modes
  424. -------------
  425.  
  426. Functions may fail for a variety of reasons, including running out of
  427. memory.  This is communicated to the caller in two ways: an error string
  428. is set (see errors.h), and the function result differs: functions that
  429. normally return a pointer return NULL for failure, functions returning
  430. an integer return -1 (which could be a legal return value too!), and
  431. other functions return 0 for success and -1 for failure.
  432. Callers should always check for errors before using the result.
  433.  
  434. Reference Counts
  435. ----------------
  436.  
  437. It takes a while to get used to the proper usage of reference counts.
  438.  
  439. Functions that create an object set the reference count to 1; such new
  440. objects must be stored somewhere or destroyed again with Py_DECREF().
  441. Functions that 'store' objects such as PyTuple_SetItem() and
  442. PyDict_SetItemString()
  443. don't increment the reference count of the object, since the most
  444. frequent use is to store a fresh object.  Functions that 'retrieve'
  445. objects such as PyTuple_GetItem() and PyDict_GetItemString() also
  446. don't increment
  447. the reference count, since most frequently the object is only looked at
  448. quickly.  Thus, to retrieve an object and store it again, the caller
  449. must call Py_INCREF() explicitly.
  450.  
  451. NOTE: functions that 'consume' a reference count like
  452. PyDict_SetItemString() even
  453. consume the reference if the object wasn't stored, to simplify error
  454. handling.
  455.  
  456. It seems attractive to make other functions that take an object as
  457. argument consume a reference count; however this may quickly get
  458. confusing (even the current practice is already confusing).  Consider
  459. it carefully, it may save lots of calls to Py_INCREF() and Py_DECREF() at
  460. times.
  461.  
  462. 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  463. */
  464.  
  465. #ifdef __cplusplus
  466. }
  467. #endif
  468. #endif /* !Py_OBJECT_H */
  469.